diff --git a/README.md b/README.md index c108479..b7ddcbf 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ More languages and functionality to come soon! - Nix is probably a good idea, then you can use what's in the nix-shell. - Just is optional, but very helpful. Also in the nix-shell if you get in there. -- Otherwise, GHC: 9.8.2, HLS: 2.7.0.0, cabal 3.10.2.1 from GHCup is what I have locally. -- do regular git-clone+cd stuff, then: + - I will be referencing this project's `just` commands here, so if you omit this, you may need to look inside the `justfile` to run each command-suite individually. +- If non-nix, GHC: 9.8.2, HLS: 2.7.0.0, cabal 3.10.2.1 from GHCup is what I have locally. Cabal will fetch the dependencies when it builds. +- Do regular git-clone+cd stuff, then: - `just shell` (aka `nix-shell --pure --show-trace`) - - Optional, but highly recommended, since I will be referencing this project's `just` commands here. - `just run --toml testProject/datatypetool.toml` (to generate files based on whats in `testProject/types/`) - `just format` (to format files for keeping things tidy) - - `just` with no arguments or `just help` will list the available commands. Right now its only 4, and this runs one of them. The other three are listed above. + - `just` with no arguments or `just help` will list the available commands. Right now there's only 4, and this runs one of them. The other three are listed above. - Language based stuff (Toml configs, language writers, etc.) are found in `app/Lang/`. Just follow whats there, keep things organized. - `*.type` file parser stuff is found in `app/Parsing/` - `datatypetool.toml` parser stuff is found in `app/Config`, except dedicated language settings, which are found in `app/Lang/**/{{Config / Toml}}.hs` diff --git a/TODO.md b/TODO.md index 113d82c..50d0b26 100644 --- a/TODO.md +++ b/TODO.md @@ -5,9 +5,10 @@ - More value constructors for Constants - Model-field metadata, defaults (and other stuff?) - More languages - - Better test suites (Perhaps self-contained in Nix shells?) - Docs. _Lots of_ Docs. Lots of _Good_ Docs. + - Actual verbosity printing/logging. - More languages + - Better test suites (Perhaps self-contained in Nix shells?) - Distribution - ??? - More languages