update: readme

This commit is contained in:
rottenwheel 2023-09-01 19:31:14 +00:00 committed by GitHub
parent fdc042e8ae
commit 3e27027829
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,22 +1,25 @@
## About ## Revuo Monero
[Emerald](https://github.com/KingFelix/emerald/) is the theme used by revuo-xmr. It is a minimal and mobile-first blog theme for Jekyll.
Revuo Monero is a weekly newsletter where you can find find the most recent Monero news.
[Emerald](https://github.com/KingFelix/emerald/) is the theme used by Revuo. It is a minimal and mobile-first blog theme for Jekyll.
## Setup & usage ## Setup & usage
To setup emerald you have to follow the steps bellow To setup emerald you have to follow the steps below:
Install ruby from [here](https://www.ruby-lang.org/en/) Install ruby from [here](https://www.ruby-lang.org/en/)
Now run the following commands: Now run the following commands:
`gem install bundler jekyll` (installs jekyll and bundler) `gem install bundler jekyll` | Installs jekyll and bundler.
`git clone https://github.com/rottenwheel/revuo-weekly` (clone the repo) `git clone https://github.com/rottenwheel/revuo-weekly` | Clone the repository.
`cd revuo-weekly` `cd revuo-weekly`
`bundle exec jekyll serve` (serve the website) `bundle exec jekyll serve` | Serve the website.
If you open your web-browser to `http://127.0.0.1:4000/` you should see revuo up and running. If you open your web browser at `http://127.0.0.1:4000/`, you should see Revuo up and running.
## License ## License
Emerald is released under [MIT License](license.md). Emerald is released under [MIT License](license.md).