Commit Graph
311 Commits
Author SHA1 Message Date
José Valim 73ef1c5845 Remove trailing newline in README 2024-02-22 08:54:22 +01:00
Kevin Genus 9100f9fee2 Fix grammar and phrasing in README.md (#13345) 2024-02-15 08:13:22 +01:00
Gonzalo 4d2a18bb83 docs: fixes README CI badge (#13278) 2024-01-23 22:14:18 +01:00
George Guimarães d1f493cff5 Update README.md with new prefers-color-scheme media feature.
The old GitHub method using #gh-dark-mode-only and #gh-light-mode-only
is deprecated and will stop working
2023-10-31 10:01:32 -03:00
George Guimarães 2b5c2a1e54 Also lint README.md using markdownlint (#13044) 2023-10-31 09:27:57 +01:00
José Valim d8d2434c49 Update ExDoc instructions 2023-07-04 17:38:30 +02:00
José Valim d773207335 make is enough to compile/install from source 2023-06-24 20:41:05 +02:00
José Valim 0b45d91cb3 Further outline the proposal process 2023-05-16 00:49:59 +02:00
José Valim 69b4c0ff20 Mention development on the README 2022-11-21 21:23:51 +01:00
José Valim eb7f640a63 Remove Cirrus CI (#12132)
It has served its purpose while developing releases
but with the functionality stable and shellcheck,
we have our basis covered.
2022-09-14 09:03:20 +02:00
José Valim 1b60acbe9e Allow LINE to be set for tests 2022-07-18 09:58:14 +02:00
Aiden Scandella e8178d8889 Update README instructions for cloning ex_doc (#11821)
GitHub says: The unauthenticated git protocol on port 9418 is no longer
supported.

```
$ git clone git://github.com/elixir-lang/ex_doc.git
Cloning into 'ex_doc'...
fatal: remote error:
  The unauthenticated git protocol on port 9418 is no longer supported.
Please see https://github.blog/2021-09-01-improving-git-protocol-security-github/ for more information.

$ git clone https://github.com/elixir-lang/ex_doc.git
Cloning into 'ex_doc'...
remote: Enumerating objects: 18840, done.
remote: Counting objects: 100% (2920/2920), done.
remote: Compressing objects: 100% (1208/1208), done.
remote: Total 18840 (delta 1813), reused 2539 (delta 1638), pack-reused 15920
Receiving objects: 100% (18840/18840), 11.29 MiB | 22.24 MiB/s, done.
Resolving deltas: 100% (10856/10856), done.
```
2022-05-12 18:43:14 +02:00
Artem Solomatin dc1c3f4a05 Fix punctuation and grammar issues in guides (#11790) 2022-05-02 10:52:37 +02:00
Simon Prévost aeffe6a75c Add dark logo in README with #gh-dark-mode-only (#11768) 2022-04-21 14:08:54 +02:00
Eksperimental 096441be32 Replace usage of comma with plus sign in "mix do" commands (#11729) 2022-03-26 16:36:37 +01:00
Eksperimental b398c9e048 Update remaining references to master branch with main (#11376)
These two have been left out in 16284830e4
2021-11-09 17:46:08 +01:00
José Valim 16284830e4 Update references to main branch 2021-11-07 20:07:38 +01:00
Akshay Narisetti ffc58c67f5 Fix some grammatical errors in README.md (#11366) 2021-11-05 07:57:36 +01:00
helloausrine b4b1b499a6 Update README.md (#11287)
Fix spelling in README.
2021-10-04 07:18:57 +02:00
José Valim fe90c14809 Update Code of Conduct
The Values section of our Code of Conduct is largely
inspired by Go's Code of Conduct, which has been updated.
We bring the majority of their updates with two small
additions:

  * Be receptive to feedback, especially those regarding
    your conduct.

  * Avoid harsh words and stern tone: we are all aligned
    towards the well-being of the community and the progress
    of the project. Harsh words exclude, demotivate, and
    lead to unnecessary conflict, rather than inspire.
2021-09-17 08:31:21 +02:00
José Valim 5deae3ee73 Update README.md 2021-09-17 07:17:00 +02:00
José Valim b7c2c879c6 Improve wording on README 2021-09-16 23:43:50 +02:00
José Valim b9f37adb66 Add a section on issues tracker management 2021-09-16 13:10:26 +02:00
José Valim 5557fe54c4 Be clear about the scope of the issues tracker 2021-09-14 11:21:58 +02:00
José Valim a3e4c441d3 Update notices 2021-08-10 13:51:42 +02:00
Justin Wood fde8ead72d Link to Libera webchat (#11015) 2021-05-27 19:08:14 +02:00
Justin Wood 18a166cb75 Change freenode reference to Libera (#11010)
There is currently no official Libera webchat setup.
I will try to update this again once one is available.
2021-05-26 15:00:11 +02:00
José Valim 8b54cb43c5 Clean up README, closes #10918 2021-04-17 22:02:51 +02:00
José Valim 176a693ef8 Require Erlang/OTP 22+ 2021-03-29 20:15:39 +02:00
Eksperimental 96d82bd8e4 Revise use of link titles (#10735)
It removes the use of indiscriminate title casing.

Pages titles in Elixir pages are not title cased.
2021-02-17 21:30:43 +01:00
Eksperimental e5d8525813 Improve grammar around "then" (#10727) 2021-02-17 16:39:16 +01:00
José Valim e3362b40d4 Update README.md 2020-11-12 17:42:35 +01:00
John Bampton 8fd9506cb7 Standardize README heading (#10163) 2020-07-08 09:00:41 +02:00
Fernando Tapia Rico bd9d18ad04 Add GitHub Actions CI badge to README (#10130) 2020-06-27 10:52:54 +02:00
José Valim 390d294906 Clarify the prompt will be similar, not precisely the same, closes #9644 2019-12-13 09:42:08 +01:00
Eksperimental 5d07658601 Introduce "format" make target (#9617)
It runs the formatter from the current elixir code,
and not from the locally or globally installed version.
2019-12-01 08:58:53 +01:00
Eksperimental 8eef0ae581 Replace usage of "etc." (#9569) 2019-11-29 08:22:18 +01:00
Glauber Campinho 1e3bc57061 Move the references from Travis CI to Cirrus CI (#9565)
[ci skip]
2019-11-19 20:43:47 +01:00
Łukasz Jan Niemier f128ae3d7a Use Erlang's logger as main logging implementation (#9333) 2019-11-01 15:53:05 +01:00
Chulki Lee 887d2a6d61 Use SPDX full name of Apache License 2.0 (#9104)
https://spdx.org/licenses/Apache-2.0.html

- Full name: Apache License 2.0
- Short identifier: Apache-2.0
2019-05-31 21:58:54 +02:00
Eksperimental 8edb70605e Review of README.md (#9086) 2019-05-28 08:10:00 +02:00
José Valim 711eca3d61 Add a note that Erlang has to be installed before compiling from source
Closes #8877
2019-03-12 13:15:40 +01:00
José Valim 41a4651319 Add Windows build badge 2019-01-29 17:15:13 +01:00
Cody Fuller 6fe87c1268 Add note about generating epub docs (#8711) 2019-01-26 09:18:15 +01:00
eksperimental 1ce9fc23b7 Replace en-dash with regular hypen
Replace en-dash "–" (U+2013 EN DASH) with regular hyphen "-" (U+002D HYPHEN-MINUS).
While correct, it is reported in  #4408 that it will not display correctly em-dashes in
Windows terminals.
README file is updated accordingly for consistency.

While https://en.wikipedia.org/wiki/Jaro–Winkler_distance uses an en-dash,
it is replaced to avoid the problem in Windows terminals, since Wikipedia
takes care of the redirection.
2018-12-11 14:42:29 +01:00
José Valim 359576ffdb Remove APPENDIX from Apache 2 file 2018-11-07 20:02:31 +01:00
Eksperimental eda797b653 Swap order of commands in README file to run make test (#8314)
If the source code is not properly formatted, `make test` would not run.

[ci skip]
2018-10-21 22:25:06 +02:00
Eksperimental d0e101fda1 Link to https://elixir-lang.org instead of to http:// (#8272) 2018-10-10 09:45:52 +02:00
José Valim 1693f830c5 Talk about the new announcement mailing list (#7996)
Promote the new announcements mailing list and how to retrieve
all security releases. Also promote the security disclosure link
more openly.
2018-07-27 15:40:34 +02:00
José Valim 9145545d4c Require Erlang/OTP 20+ 2018-07-12 12:12:00 +02:00