Commit graph

32 commits

Author SHA1 Message Date
Valentin Gagarin
933f2c086a
docs: fix link to building instructions (#11207) 2024-07-28 13:34:48 +00:00
Valentin Gagarin
a2fed6db9e
manual: Contributing -> Development, Hacking -> Building (#9014)
* manual: Contributing -> Development, Hacking -> Building

what's currently called "hacking" are really instructions for setting up
a development environment and compiling from source. we have
a contribution guide in the repo (which rightly focuses on GitHub
workflows), and the material in the manual is more about working
on the code itself.

since we'd otherwise have three headings that amount to "Building Nix",
this change also moves the "classic Nix" instructions to the top.

we may want to reorganise this in the future, and bring
contributor-oriented information closer to the code, but for now let's
stick to more accurate names to ease navigation.
2024-07-25 02:53:06 +00:00
Valentin Gagarin
b130d2f2e3
add more context on the README (#9871)
the thesis is still the defining document with all the motivation and
explanations.
adding it here for greater visibility.

also more emphasis and clarity around the community aspect.
the hydra build job seems a bit arbitrary right there. may be better for
the contributing guide.
2024-06-11 15:52:33 +00:00
Кирилл Трофимов
c9528d2081
fix: Remove extra to from README.md (#9213) 2023-10-23 19:20:23 +02:00
Robert Hensing
66a9fb0314
Merge pull request #9010 from fricklerhandwerk/first-steps
refer to nix.dev for installation instructions
2023-10-06 00:07:24 +02:00
Valentin Gagarin
80f734a803
more specific links to nix.dev 2023-10-05 09:20:42 +02:00
John Ericson
2d2aff5b92
Merge pull request #9016 from fricklerhandwerk/contributing-readme
README: link to CONTRIBUTING
2023-09-21 12:43:17 -04:00
Valentin Gagarin
984bd4cb0e README: link to CONTRIBUTING 2023-09-21 02:53:36 +02:00
Valentin Gagarin
8e25450ff4 refer to nix.dev for installation instructions
there are currently multiple places with installation instructions that
all have to be updated when a change to any of them is accepted.

this reduces the number of places by one, and directs beginners to the
maintained and curated resource for Nix learning materials.
2023-09-21 02:53:11 +02:00
Valentin Gagarin
e0e5943db2 remove IRC from links in README
the community has moved away from IRC a long time ago
2023-09-21 02:51:39 +02:00
Yorick van Pelt
f2e427942d
Improve hacking.md
- Refer to current version in readme
- Split into flakes and non-flakes section
- Change order to move nix-build to the end, since people often start
  with it in the beginning.
- Use proper "Note" syntax
- Add notes about editor integration
- Move information about target platforms and stdenvs into separate
  sections

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Alexander Bantyev <alexander.bantyev@tweag.io>
Co-authored-by: Théophane Hufschmitt <theophane.hufschmitt@tweag.io>
2023-02-13 12:00:00 +04:00
Jeremy Fleischman
297f6b5d56
Fix link to hacking doc
Right now,
https://hydra.nixos.org/job/nix/master/build.x86_64-linux/latest/download-by-type/doc/manual/contributing/hacking.html
redirects to
https://hydra.nixos.org/build/183877779/download/1/manual/contributing/hacking.html,
which gives me a "500 Internal Server Error". Not super useful =(

Feel free to ignore if someone's working to fix the 500 I was running
into.
2022-07-30 09:12:50 -07:00
Patrick Hilhorst
822e338e5c
throw freenode down the memory hole 2021-05-27 21:48:39 +02:00
Cole Helbling
093de16223
README: fix link to hacking guide 2020-12-28 09:30:14 -08:00
Mateusz Piotrowski
8b4a542d17
Fix a typo (#4073) 2020-09-26 11:33:04 +00:00
Cole Helbling
a76b8b5467
README: update link to Hacking section 2020-09-01 12:05:49 -07:00
Josef Kemetmüller
ae9e9753ce
README: Fix link to hacking guide
The link was previously interpreted as if it were relative to the current file.
2020-07-22 13:45:15 +02:00
Jörg Thalheim
f0100f5590
README: improve development docs 2020-07-20 15:46:28 +01:00
Eelco Dolstra
404a94ab69 Tweak README.md 2020-05-01 11:47:26 +02:00
Domen Kožar
2a434fc62b
Update README.md 2020-05-01 11:20:39 +02:00
Domen Kožar
30616d8e86
Update README.md
Co-authored-by: worldofpeace <worldofpeace@protonmail.ch>
2020-05-01 11:19:18 +02:00
Domen Kožar
536512d273
Update README.md
Co-authored-by: worldofpeace <worldofpeace@protonmail.ch>
2020-05-01 11:17:38 +02:00
Tobias Pflug
533343628d Revamp README.md 2020-04-30 22:03:34 +02:00
Domen Kožar
30d4618cc9
README: add github actions badge 2020-04-09 15:04:51 +02:00
Eelco Dolstra
59c37112a9 README.md: Remove reference to OpenSSL
The OpenSSL files were removed in a6ca68a70c.

https://salsa.debian.org/debian/nix/issues/3
2020-03-13 18:42:53 +01:00
Robert Hensing
9080d5d924 README, error msg: http -> https 2020-03-11 19:41:22 +01:00
Domen Kožar
5e0a64229b
Add Open Collective 2019-07-18 10:57:26 +02:00
Matt Audesse
8edf107177 Fix minor grammatical nitpick ("it's" vs. "its") in README.md.
See: http://data.grammarbook.com/blog/pronouns/1-grammar-error/
2017-03-22 10:11:23 -04:00
N1X
c8b9e47fb3 Readme semantics. 2017-01-01 05:20:47 +05:30
Eelco Dolstra
2d5a99baf0 Capitalize Nix 2016-07-21 11:08:13 +02:00
Marc Scholten
3614d55aa1 Add link to hacking section of the manual (#973) 2016-07-20 23:17:55 +02:00
Domen Kožar
040c40d3fc convert README to markdown #825 2016-05-30 15:17:51 +01:00