1hdoc¶ ↑
Keep track of your progress during #100DaysOfCode event.
Installation¶ ↑
Install 1hdoc from RubyGems:
gem install 1hdoc
or clone this repository and build the gem manually:
git clone https://github.com/domcorvasce/1hdoc cd 1hdoc gem build 1hdoc.gemspec gem install *.gem
Getting Started¶ ↑
You can get a list of available commands typing:
1hdoc --help
Configure the necessary¶ ↑
Here we are! Now you've to initialize all necessary files which are:
-
the .1hdoc.yml configuration file
Open your Terminal and type:
1hdoc
Change repo's remote origin¶ ↑
A final thing, you should edit the repo's remote origin so I can push to your account.
First of all, open GitHub or whatever you use and create a new empty repository.
Now move to the 100-days-of-code repo's folder and type:
git remote remove origin git remote add origin YOUR_REPO_URL
Hooray! We're done.
Register your progress¶ ↑
Have you ended Day 2?
Great! Let's 1hdoc track your progress. Type:
1hdoc -c
By default, 1hdoc don't push to the repo automatically after you register your progress.
You can change this behavior by assigning true
to auto_push
option in ~/.1hdoc.yml
:
:auto_push: true
Manually push to the repo¶ ↑
If you turn off auto_push
you can push to the repo typing:
1hdoc -p
FAQ¶ ↑
-
I got an error when I try to use 1hdoc. How can I resolve?
If the error is the following:
shell `require': libreadline.so.6: cannot open shared object fie
this means Ruby tries to get the older version of Readline so you need to reinstall it like reported here.
Contribute¶ ↑
Everyone can contribute to this project:
Feel free to open an issue or propose a pull request.
License¶ ↑
1hdoc is released under terms of GNU/GPL v3 license.