Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ismailarilik/pickaxe-old
A text editor written in Ruby/Tk
https://github.com/ismailarilik/pickaxe-old
Last synced: 4 days ago
JSON representation
A text editor written in Ruby/Tk
- Host: GitHub
- URL: https://github.com/ismailarilik/pickaxe-old
- Owner: ismailarilik
- License: mit
- Created: 2023-05-07T12:06:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-17T05:24:26.000Z (6 months ago)
- Last Synced: 2024-10-19T10:41:59.867Z (24 days ago)
- Language: Ruby
- Size: 29.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Pickaxe
A text editor written in Ruby/Tk
## Requirements
- Ruby 2.6 or above
- Tk 8.6
## Installation
Install the gem by cloning the repo, installing dependencies and running the `install` task:
```sh
git clone https://github.com/ismailarilik/pickaxe.git
bundle
bundle exec rake install
```
## Usage
Start Pickaxe by running `pickaxe` executable in the console:
```
pickaxe
```
## Development
After checking out the repo, run `bin/setup` to install dependencies.
Then, run `bundle exec rake` to run the static code analysis and tests.
Put your Ruby code in the file `lib/pickaxe`.
To experiment with that code, run `bin/console` for an interactive prompt.
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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ismailarilik/pickaxe.
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/ismailarilik/pickaxe/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Pickaxegem project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ismailarilik/pickaxe/blob/main/CODE_OF_CONDUCT.md).