Skip to content

Commit 60605cf

Browse files
authored
Update README.md
1 parent d294a5b commit 60605cf

File tree

1 file changed

+24
-49
lines changed

1 file changed

+24
-49
lines changed

README.md

Lines changed: 24 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,28 @@
1-
# Next.js & NextUI Template
2-
3-
This is a template for creating applications using Next.js 14 (app directory) and NextUI (v2).
4-
5-
[Try it on CodeSandbox](https://githubbox.com/nextui-org/next-app-template)
6-
7-
## Technologies Used
8-
9-
- [Next.js 14](https://nextjs.org/docs/getting-started)
10-
- [NextUI v2](https://nextui.org/)
11-
- [Tailwind CSS](https://tailwindcss.com/)
12-
- [Tailwind Variants](https://tailwind-variants.org)
13-
- [TypeScript](https://www.typescriptlang.org/)
14-
- [Framer Motion](https://www.framer.com/motion/)
15-
- [next-themes](https://github.com/pacocoursey/next-themes)
16-
17-
## How to Use
18-
19-
### Use the template with create-next-app
20-
21-
To create a new project based on this template using `create-next-app`, run the following command:
22-
23-
```bash
24-
npx create-next-app -e https://github.com/nextui-org/next-app-template
25-
```
26-
27-
### Install dependencies
28-
29-
You can use one of them `npm`, `yarn`, `pnpm`, `bun`, Example using `npm`:
30-
31-
```bash
32-
npm install
33-
```
34-
35-
### Run the development server
36-
37-
```bash
38-
npm run dev
39-
```
40-
41-
### Setup pnpm (optional)
42-
43-
If you are using `pnpm`, you need to add the following code to your `.npmrc` file:
44-
45-
```bash
46-
public-hoist-pattern[]=*@nextui-org/*
1+
# Update Guide
2+
3+
Lab members can update their bios, publications, and news on the website. The update is made through a pull request submitted by the member and approved by the website admin. Make sure your updates are accurate and properly formatted.
4+
5+
## Publications
6+
Publications are stored in `config/publications.ts`. Each publication item is a json-like dictionary, with the following fields
7+
8+
```typescript
9+
export interface Publication {
10+
title: string;
11+
authors: string;
12+
venue: string;
13+
page: string | null;
14+
paper: string;
15+
code: string | null;
16+
tags: Tag[];
17+
}
4718
```
19+
Find examples in the same file.
4820

49-
After modifying the `.npmrc` file, you need to run `pnpm install` again to ensure that the dependencies are installed correctly.
21+
## Bio
22+
The information is stored in `config/people.ts`. Update the content of yours accordingly. If you want to update your headshot, upload your photo to `/public/people`. Find examples in the same file.
5023

51-
## License
24+
## News
25+
News should be inserted here
26+
https://github.com/Graph-and-Geometric-Learning/Graph-and-Geometric-Learning.github.io/blob/d294a5bb559925e109aa7117faa575f9543da622/app/page.tsx#L44-L46
5227

53-
Licensed under the [MIT license](https://github.com/nextui-org/next-app-template/blob/main/LICENSE).
28+
The news item should be wrapped by `<li>...</li>`. Wrap the text with `<Link href="link.com">...</Link>` if you want to add a link to your text. Check examples in the same file for reference.

0 commit comments

Comments
 (0)