timkaechele/rex
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add rudimentary readme

Browse Source
This commit is contained in:
Tim Kächele 2024-02-18 21:30:50 +01:00
parent ede4916284
commit ab3f5d89b5
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,35 +1,37 @@
# Rex
TODO: Delete this and the text below, and describe your gem
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rex`. To experiment with that code, run `bin/console` for an interactive prompt.
Rex is an implemenation of an order book and an accompanying
matching engine.
## Installation
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
Clone this repository
Install the gem and add to the application's Gemfile by executing:
```sh
$ git clone git@git.timkaechele.me:timkaechele/rex.git
```
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
Install the gem
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
```sh
$ rake install
```
## Usage
TODO: Write usage instructions here
### Start a simple exchange server
## Development
Use the built-in command line tool to start a simple server
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
```sh
# Start a server that binds to 0.0.0.0 and listens on port 8080
$ rex-server 0.0.0.0 8080
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rex/blob/main/CODE_OF_CONDUCT.md).
Bug reports and pull requests are welcome on GitHub at https://git.timkaechele.me/timkaechele/rex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://git.timkaechele.me/timkaechele/rex/src/branch/main/CODE_OF_CONDUCT.md).
## Code of Conduct
Everyone interacting in the Rex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rex/blob/main/CODE_OF_CONDUCT.md).
Everyone interacting in the Rex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://git.timkaechele.me/timkaechele/rex/src/branch/main/CODE_OF_CONDUCT.md).