Zach/manual

[ZachJHansen]

No description provided.

[teiesti]

Very nice work.

[ZachJHansen]

Thanks for looking this over! I implemented your comments and re-submitted the PR. Best, Zach

…

On Nov 20, 2024, at 5:06 AM, Tobias Stolzmann ***@***.***> wrote: @teiesti requested changes on this pull request. Very nice work. On Dockerfile <#157 (comment)>: I have never used Docker and I am wondering if such a file should go into an entirely new repository. At least that is how I've seen it done with other deployment methods in other project. That said, I am not opposed to this change. I trust your decision. In Dockerfile <#157 (comment)>: > +RUN apt install -y git +RUN apt-get install -y vim + +# Install Rust and Cargo +RUN curl https://sh.rustup.rs -sSf | sh -s -- -y + +# Install Vampire v4.9 (statically linked) +RUN wget https://github.com/vprover/vampire/releases/download/v4.9casc2024/vampire +RUN mv vampire /usr/bin/ +RUN chmod +x /usr/bin/vampire + +# Install Anthem +RUN git clone https://github.com/potassco/anthem.git +RUN cd anthem && . "$HOME/.cargo/env" && cargo build --release +RUN cp anthem/target/release/anthem /usr/bin/ +RUN chmod +x /usr/bin/anthem Once we've published our crate to crates.io, installing the current stable version of anthem is as simple as cargo install anthem. I think, we should use this here. In res/manual/src/installation.md <#157 (comment)>: > @@ -0,0 +1,25 @@ +# Installing From Crates.io +tbd + +# Installing From Source +Linux users can build `anthem` directly from source, as follows. + +``` + git clone https://github.com/potassco/anthem.git && cd anthem + cargo build --release + cp anthem/target/release/anthem /usr/bin/ Two things: It is not wise to manually install executables to /usr/bin/ because this folder is usually managed by the system's package manager. Install to /usr/local/bin instead. Installing software to a subdirectory of /usr makes it available to all users of a system and therefore requires root privileges. Thus, this method might not work for all our users. The much safer option is to install to ~/.local/bin. In res/manual/src/installation.md <#157 (comment)>: > @@ -0,0 +1,25 @@ +# Installing From Crates.io +tbd + +# Installing From Source +Linux users can build `anthem` directly from source, as follows. + +``` + git clone https://github.com/potassco/anthem.git && cd anthem + cargo build --release + cp anthem/target/release/anthem /usr/bin/ + chmod +x /usr/bin/anthem I don't think that is necessary because the file creates by cargo is already executable. On Dockerfile <#157 (comment)>: Update: After thinking about it, we could also put deployment methods into separate branches. When creating such a branch I'd use the --orphan flag <https://graphite.dev/guides/git-orphan-branches>. — Reply to this email directly, view it on GitHub <#157 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGKMMRZONS4ZYSUVXPF7ZNT2BRUMVAVCNFSM6AAAAABRSIYJ6CVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDINBYGI2DKNZZHE>. You are receiving this because you authored the thread.