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.

Sign up for GitHub

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

update to readme file #54

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

update to readme file #54

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aabb529
Update README.md
NafizChaw Sep 26, 2024
adfa76c
Update README.md
NafizChaw Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 42 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# getkap.co (Kap Website)

Repository for the [Kap] website, built with [Next.js](https://github.com/zeit/next.js) and powered by [Vercel](https://vercel.com)
Repository for the [Kap] website, built with [Next.js](https://github.com/zeit/next.js) and powered by [Vercel](https://vercel.com).

## Introduction
Kap is a free and open-source screen recording application designed for macOS. This repository contains the source code for the official Kap website, which showcases the features of the app, provides download links, and offers support and resources for users and contributors. The website is built using Next.js and powered by Vercel.

## Table of Contents
1. [Development](#development)
- [Requirements](#requirements)
- [Making Changes](#making-changes)
2. [Related Repositories](#related-repositories)
3. [Newsletter](#newsletter)
4. [FAQ](#faq)
5. [How to Get Help](#how-to-get-help)
6. [License](#license)

## Development
### Requirements

1. Have [node.js] installed
2. [Fork] and clone the repository to your machine
3. `yarn` or `npm install` to install the relevant node packages
3. Run `yarn` or `npm install` to install the relevant node packages

### Making changes

Expand All @@ -24,6 +37,33 @@ Run `npm run dev` or `yarn dev` to start the website in dev mode.

[Subscribe for updates](http://eepurl.com/ch90_1).

## FAQ

### 1. What is Kap?
Kap is an open-source screen recording app built for macOS. This repository is specifically for its website.

### 2. How do I install and run the website locally?
To run the website locally:
1. Clone the repository and install the required node packages using `npm install` or `yarn`.
2. Run `npm run dev` or `yarn dev` to launch the website in development mode.

### 3. Can I contribute to the website's development?
Yes! You can contribute by forking the repository, making your changes, and submitting a pull request.

### 4. What technologies are used for this website?
The Kap website is built using [Next.js](https://nextjs.org/) and powered by [Vercel](https://vercel.com), a platform for deploying Next.js applications.

### 5. Where can I find the code for the Kap app itself?
You can find the code for the Kap screen recording app in [this repository](https://github.com/wulkano/kap).

## How to Get Help
If you run into any issues or have questions, there are several ways to get help:
- Open a [GitHub Issue](https://github.com/wulkano/kap/issues).
- Visit our [community forum](https://getkap.co/community) for discussion and support.
- Check out the official [Kap Documentation](https://getkap.co/docs).

## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/wulkano/kap/blob/main/LICENSE) file for details.

[Kap]: https://getkap.co
[node.js]: https://nodejs.org
Expand Down