diff --git a/Makefile b/Makefile index 4eb217b..eae7d06 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,7 @@ build: clean .PHONY: check check: $(BINARY) - @crystal spec + @crystal spec --tag ~online .PHONY: clean clean: @@ -18,4 +18,4 @@ clean: .PHONY: run run: $(BINARY) - $(BINARY) + $(BINARY) \ No newline at end of file diff --git a/README.md b/README.md index c38c511..901232c 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,72 @@ -# crystal2nix -Helps nixify crystal projects. + [NixOS](https://nixos.org) + +# Crystal2Nix + +Crystal2Nix is a tool designed to generate Nix expressions for Crystal projects. It simplifies the process of managing dependencies and building Crystal applications within the Nix ecosystem. + +## Features + +- Automatically generates Nix expressions from `shard.yml` files. +- Supports Crystal projects with various dependencies. +- Building and managing Crystal applications. + +## Table of Contents + +- [Installation](#installation) +- [Usage](#usage) +- [Testing](#testing) +- [Contributing](#contributing) +- [License](#license) + +## Installation + +### Prerequisites + +- [Nix](https://nixos.org/download.html) installed on your system. +- [Crystal](https://crystal-lang.org/install/) programming language installed. +>>>>>>> 0e63fe2 (init at 0.1.0) ## Installation -You don't need to install it. With nix installed you can just run it: +You don't need to install crystal2nix manually. With Nix installed on your system, you can run it directly using the following command: `nix-shell -p crystal2nix --run crystal2nix` ## Usage +To generate a Nix expression for your Crystal project, simply run: + `crystal2nix` -## Development +## Testing + +Unit Tests: These tests can be run within the Nix sandbox without requiring network connectivity. + +`make check ` # Runs unit tests + +## Future plans -We will welcome all help with open arms! +Support for Fossil resources: Expanding source control compatibility. +Additional integration test cases: Enhancing the robustness of our test suite. ## Contributing +We value contributions from the community. If you have suggestions, bug reports, or improvements, please submit them through GitHub issues or pull requests. Your involvement helps us make crystal2nix better for everyone. + 1. Fork it () 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new Pull Request +## License + +crystal2nix is licensed under the MIT License. You are free to use, modify, and distribute this software under the terms of this license. + ## Contributors - [Michael Fellinger](https://github.com/manveru) - [Peter Hoeg](https://github.com/peterhoeg) +- [Vidhvath J](https://github.com/vidhvath28) +