chore,docs: add Nix shell, update readme accordingly

This commit is contained in:
Lucien Cartier-Tilet 2024-04-01 06:47:09 +02:00
parent 345e8d04c8
commit 83aa372345
Signed by: phundrak
GPG Key ID: BD7789E705CB8DCA
2 changed files with 19 additions and 4 deletions

View File

@ -57,14 +57,20 @@ npm install # delete the yarn.lock file first
Once this is done, you can launch a preview of the project.
#+begin_src shell
yarn docs:dev
yarn dev
# or
npm run docs:dev
npm run dev
#+end_src
You can also compile the project to a static website.
#+begin_src shell
yarn docs:build
yarn build
# or
npm run docs:build
npm run build
#+end_src
** With Nix shell
A Nix shell is available for running the project without the Emacs
part. Simply run =nix-shell= in the project root. Youll get the latest
version of =yarn= installed and should be able to run the commands
above.

9
shell.nix Normal file
View File

@ -0,0 +1,9 @@
{ pkgs ? import <nixpkgs> {} }:
pkgs.mkShell {
nativeBuildInputs = with pkgs.buildPackages; [
corepack
];
shellHook = ''
yarn set version stable
'';
}