Add README

This commit is contained in:
OCDkirby 2024-09-14 19:56:38 +10:00
parent 8c0a5175e7
commit 3dce7f8d49
2 changed files with 23 additions and 1 deletions

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# RPCSX Wiki
## Contributing
### Project Setup
Dependencies: Ruby 3.x
```sh
gem install bundler
git clone https://github.com/RPCSX/wiki
cd wiki
bundle install
```
### Compile and Hot-Reload for Development
Note: hot reloading is unsupported, refresh the page to see your changes.
```sh
bundle exec jekyll serve
```
### Pushing your changes
Kindly run `rubocop` on your local files before pushing your changes. Thanks!

View File

@ -58,7 +58,8 @@ webrick:
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
# exclude:
exclude:
- README.md
# - .sass-cache/
# - .jekyll-cache/
# - gemfiles/