Skip to content

Update README.md with detailed step by step local build info#171

Closed
davelab6 wants to merge 1 commit intomainfrom
davelab6-readme-steps
Closed

Update README.md with detailed step by step local build info#171
davelab6 wants to merge 1 commit intomainfrom
davelab6-readme-steps

Conversation

@davelab6
Copy link

@davelab6 davelab6 commented Jun 3, 2025

cd fontra-pak ;
python3 -m venv venv ;

3. Install the python package requirements:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's missing the venv activation step.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just thought the Same 😬


5. Run the application:

./dist/Fontra\ Pak ;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be incorrect for macOS and Windows.

## Download

Nightly builds can be downloaded from the topmost [“Build Application”](https://github.com/googlefonts/fontra-pak/actions) workflow. You need to be signed in to GitHub to be able to download.
Nightly builds can be downloaded from the topmost [“Build Application”](https://github.com/googlefonts/fontra-pak/actions) workflow.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nightly builds can also be downloaded from fontra.xyz, which doesn't require GH login. We should probably mention that first.

@justvanrossum justvanrossum mentioned this pull request Dec 15, 2025
@justvanrossum
Copy link
Member

justvanrossum commented Dec 15, 2025

This is superseded by #208.

Perhaps there need to be more detailed instructions to run or build from the sources on Linux, but I think these should be added to the docs instead, as these are more targeted towards end users:

I don't think the readme in this repo needs to explain how to clone a repo and how to set up a virtual environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants