Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Instructions for compilation are a little confusing: docs need to be updated #173

Open
frogeyedpeas opened this issue May 8, 2024 · 1 comment · May be fixed by metamath/metamath-website-seed#24

Comments

@frogeyedpeas
Copy link

Hi in the downloads page instructions are given for getting started with metamath. In particular after unzipping the .tar.gz one cannot immediately run gcc *.c -o metamath and expect it to work. They need to update the command to gcc src/*.c -o metamath or cd into src before executing the command.

https://us.metamath.org/index.html#downloads

On May 07, 2024 I downloaded the file [metamath.tar.gz](https://us.metamath.org/downloads/metamath.tar.gz) onto my Mac running Mac OS Big Sur.

After downloading this file I unzipped it with tar xvzf this command ran successfully and created a metamath directory.

I was able to cd into this directory and here are its contents

Screen Shot 2024-05-07 at 10 23 23 PM

At this stage of the instructions something goes awry
Screen Shot 2024-05-07 at 10 23 48 PM

The instructions clearly state to run gcc *.c -o metamath however as my screenshot above shows, there are no .c files to be found in the root and so when I run it it fails as expected.

Screen Shot 2024-05-07 at 10 24 44 PM

I believe that this command needs to be run from the src directory which appears to have all the .c and .h files needed.

Screen Shot 2024-05-07 at 10 25 23 PM

This command appears to work fine. And furthermore executing ./metamath set.mm afterwards seems to be fine:

Screen Shot 2024-05-07 at 10 26 48 PM
@digama0
Copy link
Member

digama0 commented May 8, 2024

I think the recommended instructions should be to just run ./build.sh, which is a lot easier to remember and also breaks less often. It's quite awkward for the installation instructions to be outside of the repository; we should have the website just point to a markdown page or the readme on this repo instead, for anything more complicated than ./build.sh.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants