Skip to content

Commit

Permalink
website update
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Dec 15, 2024
1 parent 8cb8b47 commit c8ea1c4
Show file tree
Hide file tree
Showing 5 changed files with 144 additions and 127 deletions.
5 changes: 4 additions & 1 deletion website/docs/getting-started/glossary/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,12 @@ The definitions used in the **xpm** project are listed below.

### xpm

**xpm** is the xPack Project manager. It uses several concepts and definitions:
**xpm** is the **xPack Project Manager**. It uses several concepts and definitions:

- **xPacks (xpm packages)**: software packages managed by **xpm**; an extension of **npm** packages
- **author**: from **npm** point of view, the package author is the person who
maintains the package metadata; it may or may not be the same person who wrote the library source code or the binaries
- **contributors**: from **npm** point of view, these are the persons who contributed code to the package, i.e. who wrote the the library source code or the binaries; for 3rd party packages, they are usually different from the package _authors_
- **dependencies**: source packages required by the current project during compile/link time
- **development dependencies**: tools required during development of the current project
- **actions**: sequences of shell commands executed in the environment of the current project dependencies
Expand Down
7 changes: 4 additions & 3 deletions website/docs/guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ date: 2024-11-26 01:34:00 +0200

This section is intended for those who plan to add xPack metadata to their projects and provides documentation on how to create new packages.

## Chapters
## Sections

1. [Concepts](./concepts/)
1. [Metadata](../metadata/)


1. [Files](../files/)
1. [Project Templates](../project-templates/)
1. [New GitHub Project](../new-github-project/)
35 changes: 20 additions & 15 deletions website/docs/guide/new-github-project/_create-github-project.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,17 +54,17 @@ git clone https://github.com/<user>/<project>.git <project>.git

### Edit the master `README.md` file

As mentioned in the introduction,
although for original xPacks there are no constraints on how to
organise the branches, for consistency with xPacks that use 3rd
party content, it is recommended to use an `xpack` branch.
As mentioned in the introduction, although there are no constraints
on how to organise branches for original xPacks, it is recommended
to use an `xpack` branch for consistency with xPacks that utilise
third-party content.

In this case, to warn users about this configuration, edit
the `README.md` file; keep the header line and replace the content with:
In this case, to inform users about this configuration, edit the
`README.md` file. Retain the header line and replace the content with:

```text
This project does not use the `master` branch, please
switch to the `xpack` branch to get the project files.
switch to the `xpack` branch to access the project files.
```

With VS Code, Fork or Git:
Expand All @@ -75,10 +75,10 @@ With VS Code, Fork or Git:
### Edit the `LICENSE` file

The automatically generated `LICENSE` file already includes the
user name as the copyright owner. When the project is owned by
an organisation, the name refers to the organisation. Probably
this is not exactly what you need, and you might prefer to have
your name in the copyright notice.
username as the copyright owner. When the project is owned by an
organisation, the name refers to the organisation. This may not
be exactly what you need, and you might prefer to have your name
in the copyright notice.

Check and possibly adjust to match your `LICENSE` requirements.

Expand All @@ -87,7 +87,7 @@ For example, xPack projects use:
```text
MIT License
Copyright (c) 2022 Liviu Ionescu. All rights reserved.
Copyright (c) 2024 Liviu Ionescu. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
...
Expand All @@ -102,6 +102,11 @@ With VS Code, Fork or Git:

With VS Code, Fork or Git:

- select the `master` branch
- create new branch `xpack`
- switch to it
<ul>
<li>select the `master` branch</li>
<li>create a new `xpack` branch</li>
<li>switch to it</li>
{props.doReconstruct === "true" ? (<li>rename <code>LICENSE</code> to <code>LICENSE-XPACK</code>.</li>) : (<></>)}
{props.doReconstruct === "true" ? (<li>rename <code>README.md</code> to <code>README-XPACK.md</code>.</li>) : (<></>)}
<li>Push the `xpack` branch</li>
</ul>
Loading

0 comments on commit c8ea1c4

Please sign in to comment.