From bc35d225d2df46740fc8a2255e7619de33eaccc1 Mon Sep 17 00:00:00 2001 From: Ashe Connor Date: Tue, 14 Jan 2020 15:28:42 +1100 Subject: [PATCH] readme updates --- .gitignore | 3 +++ README.md | 6 +++--- contributors.txt | 3 +++ script/Dockerfile | 22 ---------------------- script/Gemfile | 3 +++ 5 files changed, 12 insertions(+), 25 deletions(-) delete mode 100644 script/Dockerfile create mode 100644 script/Gemfile diff --git a/.gitignore b/.gitignore index a9d37c56..3aed9fd7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ target Cargo.lock +script/.bundle +script/Gemfile.lock +script/vendor diff --git a/README.md b/README.md index eb73b890..e03acd41 100644 --- a/README.md +++ b/README.md @@ -146,8 +146,8 @@ By default none are enabled; they are individually enabled with each parse by se Comrak's design goal is to model the upstream [`cmark-gfm`](https://github.com/github/cmark-gfm) as closely as possible in terms of code structure. The upside of this is that a change in `cmark-gfm` has a very predictable change in Comrak. -It helps that I maintain both, and tend to update Comrak in lock-step with `cmark-gfm`. Likewise, any bug in `cmark-gfm` -is likely to be reproduced in Comrak. This could be considered a pro or a con, depending on your use case. +Likewise, any bug in `cmark-gfm` is likely to be reproduced in Comrak. This could be considered a pro or a con, +depending on your use case. The downside, of course, is that the code is not what I'd call idiomatic Rust (*so many `RefCell`s*), and while contributors and I have made it as fast as possible, it simply won't be as fast as some other CommonMark parsers @@ -174,7 +174,7 @@ project. Thank you to comrak's many contributors for PRs and issues opened\! -
anthonynguyen ayosec bovarysme brson carols10cents ConnyOnny ctm DemiMarie gjtorikian ignatenkobrain ivanceras JordanMilne jrmiller82 Keats killercup lise-henry maxwell-k SSJohns steveklabnik sunjay treiff zeantsoi +
andersk anthonynguyen ayosec bovarysme brson carols10cents colindean ConnyOnny ctm DemiMarie gjtorikian ignatenkobrain ivanceras JordanMilne jrmiller82 Keats killercup lise-henry maxwell-k mity SSJohns steveklabnik sunjay treiff zeantsoi ## Legal diff --git a/contributors.txt b/contributors.txt index 7ff81c0e..d4b16ccc 100644 --- a/contributors.txt +++ b/contributors.txt @@ -20,3 +20,6 @@ lise-henry maxwell-k jrmiller82 ignatenkobrain +colindean +mity +andersk diff --git a/script/Dockerfile b/script/Dockerfile deleted file mode 100644 index cadc56b2..00000000 --- a/script/Dockerfile +++ /dev/null @@ -1,22 +0,0 @@ -FROM debian:stretch - -RUN apt-get update && apt-get install -y \ - build-essential autoconf libtool \ - git \ - pkg-config \ - && apt-get clean - -RUN apt-get install -y \ - cmake \ - gdb \ - valgrind \ - python3 - -RUN apt-get install -y wget -RUN cd /tmp && wget https://static.rust-lang.org/rustup/dist/x86_64-unknown-linux-gnu/rustup-init -RUN cd /tmp && chmod +x rustup-init && ./rustup-init -y --default-toolchain nightly -RUN echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> /root/.bashrc - -RUN apt-get install -y vim-common -RUN apt-get install -y time -RUN apt-get install -y linux-perf diff --git a/script/Gemfile b/script/Gemfile new file mode 100644 index 00000000..e0ba401d --- /dev/null +++ b/script/Gemfile @@ -0,0 +1,3 @@ +source "https://rubygems.org" + +gem "commonmarker"