Alternative instructions for installation

srid / neuron

Future-proof note-taking and publishing based on Zettelkasten (superseded by Emanote: https://github.com/srid/emanote)

https://neuron.zettel.page

GNU Affero General Public License v3.0

1.52k stars 150 forks source link

Alternative instructions for installation #103

Closed luc-tielen closed 4 years ago

luc-tielen commented 4 years ago

A couple of days ago I mentioned neuron to a friend of mine (@hanskenis) who became enthousiastic about it. However today he tried installing it on MacOSX Catalina (which has issues with nix) and he immediately became stuck.. and the enthousiasm quickly dissapeared. 😞

Is it possible to have instructions for a cabal / stack install as well? I think it would open up neuron for a much bigger audience.

srid commented 4 years ago

@luc-tielen Could you encourage your friend to try these instructions for Catalina. I'm sure it will be a smooth ride afterwards.

Is it possible to have instructions for a cabal / stack install as well?

Yes, it is possible. We need to get rib into stackage, and then the which package as well. Finally the neuron package (all of this will also automatically make it available in nixpkgs). Then you would be able to just do stack install neuron. This is tracked in #45

In the interim, it may be possible to have a stack.yaml to specify the custom dependencies. But I'm not familiar with Stack. In any case, I strongly encourage people to try Nix. :-)

luc-tielen commented 4 years ago

I did suggest it to him but he ended up finding it too much work (since he's not normally a nix user). Once the packages are in stackage he might try installing it again.

srid commented 4 years ago

If anybody wants to try it, here is way to "try before you buy it" neuron. You only need to have docker installed:

mkdir ~/zettelkasten
echo -e "---\ntitle: Test\n---\n\nThis is a test" > ~/zettelkasten/2011201.md

docker run --rm \
  -v ~/zettelkasten:/root/zettelkasten \
  -p 8080:8080 \
  -t sridca/neuron:test \
  neuron rib -o /tmp/site -ws 0.0.0.0:8080

luc-tielen commented 4 years ago

Ah, I didn't even think of Docker.. guess that's what happens if you use nix for too long 😄. I can confirm that it works, nice addition!

srid commented 4 years ago

Alright, I'm going to close this.

I realized only over time that Nix is integral to neuron development (for eg., neuron-search relies on Nix), so stack-based install is unlikely to happen.
If people don't want to use Nix, they can use Docker (the alternative install option) after #146 is done.

luc-tielen commented 4 years ago

That's ok, I think Docker is a good alternative that a lot of people have installed already.