Commit Graph

52 Commits

Author SHA1 Message Date
irisjae
9be884ba3e
Fix README link for "Contributing" 2023-04-27 16:57:40 +08:00
DavHau
986480a327 docs: acknowledge funding more
- Move funding section to the top of the readme
- add funding paragraph to the intro of the docs
2022-12-15 14:04:37 +07:00
DavHau
011b8ba238 add example for defining projects as attrs 2022-12-13 13:40:46 +07:00
DavHau
01b5d43524 chore: use projects.toml in docs and examples 2022-12-13 12:42:03 +07:00
DavHau
b6af939461
chore: add dark logo to readme 2022-11-30 00:43:59 +07:00
Márton Boros
63892634b8
Fix readme formatting 2022-11-21 22:22:52 +02:00
Yusuf Bera Ertan
bc994d0eed
docs: add pkgs-rust badge to readme 2022-11-14 02:03:56 +03:00
DavHau
20fa990465 add stats for ecosystems to readme 2022-11-09 23:06:19 +01:00
Isaac Shapira
1692d0e3be
Update README.md 2022-08-16 16:46:19 -06:00
DavHau
e8fe3f803f rename examples under ./examples
Apply naming scheme {subsystem}_{test-name}
2022-07-22 16:02:21 +02:00
DavHau
9ce7b78c1f
Revert "refactor: readme/docs" 2022-07-18 18:58:36 +02:00
DavHau
3808b309dc refactor: readme/docs
The motivation of this change is to trim down the github front page (README.md). Code examples should not be part of that page. It should be short and only contain the most important information that's necessary for a rough overview.

- add sections `Quick Start` and `Presentation ...` to docs
- move usage examples from readme to `Quick Start` in the docs
- trim down the explanation about `Documentation` a bit
- move the youtube presentation to the end
-
2022-07-17 21:17:41 +02:00
DavHau
7cd64d386d python improvements, docs and guide.
- add warning to readme and docs stating that dream2nix is unstable software
- refactor structure of docs: remove title .md pages, instead add titles via (# title) to SUMMARY
- change order of doc topics. move `guides` and `subsystems` to the front
- add docs for python subsystem
- add getting started guide for python
- extend ./examples/python to make use of translator options
- add new function to dlib `systemsFromFile` that allows to load the `supportedSystems` from a file. This alows changing the supported systems without touching the flake.
- move pip translator args to extra file `args.nix` to allow embedding in docs
- fix pip translator
- add a .gitignore to the basic flake template
- use new systemsFromFile function in basic flake template
2022-07-16 15:03:37 +02:00
Lele Gaifax
c69534abef Fix typos in documentation 2022-07-14 11:31:44 +02:00
DavHau
10fecabe3a
add devShell outputs for nodejs ad python (#186)
* add devShell outputs for nodejs ad python

* nodejs devShell improvements

- do not export NODE_PATH
- create node_modules directory
- add .bin directories of direct dependencies to PATH

* nodejs: revise devShell logic

- fix namespaced modules symlinking to ./node_modules
- add all transitive exectables to ./node_modules/.bin
- add ./node_modules/.bin to PATH

* set nodejs version in eslint example

* nodejs: improve error message on failed node_modules symlink in devShell

* readme: add nodejs version setting to example
2022-07-12 18:54:35 +02:00
Yusuf Bera Ertan
d05c074a97
docs(readme): update docs cli app instructions, fix formatting 2022-06-21 19:11:02 +03:00
Yusuf Bera Ertan
7005441ceb
docs: setup mdbook book for documentation, add CLI app for docs (#173)
* docs: setup mdbook book for documentation

* ci: add github action for docs

* docs: add a cli command for showing docs in terminal

* Update docs/src/subsystems/rust.md

Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com>

* docs(rust): add example for crane overriding

* docs: add a further reading section to intro

* docs: fix a few links

* docs(readme): move documentation section up and fit some sections into 80 columns

Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com>
2022-06-13 22:27:05 +03:00
Yusuf Bera Ertan
9b6638a1a7
feat: implement makeOutputs that outputs systemless structure (#161)
* feat: return underlying d2n instance if pkgs was passed to init, document init pkgs

* feat: implement makeOutputs

* tests: dont fail if resolveImpure fails

* feat: make init return a dream2nix instance, rework makeFlakeOutputs code

* feat: default to source if config.projectRoot is not specified, update examples and readme

* fix: update the simple template

* docs: clarify init in readme

* docs: change readme numbering to back to 1

* refactor: dont default projectRoot to source

* docs: make extensive example use makeFlakeOutputs, link per-pkgs d2n example in readme

* fix: call loadConfig correctly
2022-06-01 22:53:46 +02:00
Yusuf Bera Ertan
645c6fd98e
refactor: implement a validation system for builders / translators, reorganize files (#155)
* refactor: implement a validation system for builders / translators etc, organize files

* refactor: use seq instead of complicated validation function for validator

* feat: allow adding discoverers, translators and builders via config

* refactor: rework discoverers to use makeSubsystemModules as well

* fix: validate extra modules properly

* feat: support inline modules

* feat: use extra attribute for extending

* feat: make fetchers extensible properly

* fix: add name to extra fetchers

* feat: support list for extra

* docs: add some comment to lib/modules.nix

* fix: get extra module args from extraArgs

* fix: collect all modules instead of only collecting modules for built-in subsystems

* refactor: minor improvements

* refactor: improve how default subsystem modules are declared

* fix: translators and builders are directly under subsystem now

* fix: correct attribute path, remove unused argument

* fix: correct translators attribute paths

* fix: correct file paths and translators attribute paths

* fix: use correct translator attr path in wrapPureTranslator

* fix: update unit tests code

* fix: remove extra paranthesis in unit tests code

* tests: add an extended dream2nix example

* refactor: replace recursiveUpdate usage with normal update op

* tests: fix and extend d2n-extended example

* fix: pass config to d2n instance in wrap pure translator script

* fix: correct toFile usage

* fix: pass config to dlib in more places

* fix: pass config to d2n instance in aggregated hashes cli and gomod2nix translator

* refactor: remove unused extra modules validation, add warning for function modules

* fix: remove non-existent inherited variable

* docs: update translator attr path in contributors guide

* docs: add docs for extending dream2nix

* refactor: comment more code, warn for function modules only if extra is an attrset decl

* docs: fix some typos

* docs: explain some stuff in extending d2n better

* fix: print function modules warning when it is a function

* tests: add a new example that tests adding new subsystem and config.extra as nix file

* tests: use cargo-toml as translator on d2n-extended to potentially catch more bugs

* feat: add ifd warning for builders

* tests: use build-rust-package builder instead of crane builder in d2n-extended to also test it instead of only testing crane builder

* fix(rust/builders): always write the generated Cargo.lock so it doesnt get out of sync with our dream-lock

* fix(rust/builders): delete cargo lock before writing it?

* refactor: also print ifd warnings for translators

* docs: link extending d2n doc in readme, link examples in extending d2n

* docs: example naming (translators.new -> translators.example-translator)

* feat: allow setting nix files for modules declarations (eg. subsystems, subsystems.translators)

* refactor: move IFD warnings to src/lib/builders.nix / translators.nix respectively

* refactor: throw instead of warning if function declarations for modules are used

* refactor: fix throw usage

* refactor: improve modules code

* chore(deps): update nixpkgs

* fix: correct some map usages

* fix: use correct attr path for extra modules

* chore: update examples flake inputs

* style: minor formatting changes
2022-05-29 21:42:47 +02:00
olaf
bc499a3003
Update README.md (#154)
fix pkgs variable
2022-05-21 10:37:44 +03:00
DavHau
1215fff66b readme: fix typo 2022-05-19 16:07:34 +02:00
DavHau
9003aed816 readme: ad section funding 2022-05-15 19:04:07 +02:00
DavHau
6672d1f3d9 update readme: wording, glossary
fixes #132
2022-05-03 22:33:08 +02:00
dusk
97d32e314e
docs: fix sourceOverrides usage in readme example (#134) 2022-04-29 11:17:34 +02:00
happysalada
e478b3c950 readme: add special format example 2022-04-24 09:12:28 -04:00
DavHau
f463c07660 readme: add extensive example flake.nix
Also update wording
Closes #122
2022-04-24 11:26:36 +02:00
DavHau
867c1dbce5 add matrix link to readme 2022-03-12 21:07:27 +07:00
DavHau
5dcfbfd3b6 readme: add packageOverrides example 2022-03-08 10:32:14 +07:00
DavHau
42507e645c remove dreampkgs reference from readme 2022-02-25 12:52:44 +07:00
DavHau
5ad9714afd reword readme example flake 2022-02-23 17:50:02 +07:00
DavHau
767db79095 raname: riseAndShine -> make[Flake]Outputs 2022-02-22 20:21:33 +07:00
DavHau
3d66429c69 remove mentions of generic in readme
(frameworks are generic by default)
2022-02-14 13:19:38 +07:00
DavHau
ea3d1a2ac1 simplify example flake.nix
fixes a bug where a source tree input was interpreted as a laoded dream-lock
2022-02-09 15:13:49 +07:00
DavHau
e65605e3e3 add example flake.nix to readme 2022-02-09 10:17:51 +07:00
DavHau
9374c14ac4 fix typo in readme 2021-11-07 21:31:24 +07:00
DavHau
d23ab941ca link dreampkgs in readme 2021-11-07 18:48:16 +07:00
DavHau
d56edddc3e document override system 2021-11-07 15:18:28 +07:00
DavHau
f26dc00567 add video presentation + refactor readme 2021-10-16 19:12:07 +07:00
DavHau
7d45914c49 add dream2nix logo 2021-10-13 07:23:32 +07:00
DavHau
443f4a983b docs: minor readme improvements 2021-09-30 01:35:46 +01:00
DavHau
64c0b7036b docs: add contributors guide 2021-09-30 01:35:46 +01:00
DavHau
e08781be14 docs: improve readme + nixpkgs section 2021-09-30 01:35:46 +01:00
DavHau
d6fc258333 docs: restructure + add nixpkgs-improvements.md 2021-09-30 01:35:46 +01:00
DavHau
f3444c90f7 add app 'contribute' to initialize templates 2021-09-24 14:19:48 +01:00
DavHau
aa7902a09e improve translators:
- translator flags
  - translatedBy
  - translatorParams
2021-09-18 01:06:48 +01:00
DavHau
d83d76d5ef improve handling of translator modules 2021-09-13 18:08:28 +01:00
DavHau
4a00410a2b add support for opt-in FOD fetching
- will ommit storing individual hashes, reducing lock file size
2021-09-11 00:06:48 +02:00
DavHau
72bbad7d9d minor fixes 2021-09-10 10:15:44 +02:00
DavHau
094b4c92fa update readme/docs/schemas 2021-09-07 00:08:13 +02:00
DavHau
fe2fdd25ae improve readme, add docs/translators.md 2021-09-06 16:57:34 +02:00