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

There is no README.md in default initial root directory. #302

Closed
FanTuanCat opened this issue Jan 10, 2024 · 3 comments · Fixed by #352
Closed

There is no README.md in default initial root directory. #302

FanTuanCat opened this issue Jan 10, 2024 · 3 comments · Fixed by #352
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request refactoring ui

Comments

@FanTuanCat
Copy link
Contributor

I am trying to build the UI of mega, but I need a REAEME.md file to test and presentation effects.
Please add a README.md file in default initial root directory.

## Init directory configuration
MEGA_INIT_DIRS = "projects,docs,third_parts" # init these repo directories in mega init command
@benjamin-747
Copy link
Collaborator

hi @YutingNie, this configuration is used to init directory for repo storage, if you want a readme file for testing, you can push one of your repo to mega server by following the next steps:

  • first add an new repositories url in your repo: git remote add local http://localhost:8000/projects/mega.git
  • using git push to push data to server: git push local main

@benjamin-747 benjamin-747 added the documentation Improvements or additions to documentation label Jan 11, 2024
@genedna genedna added enhancement New feature or request ui refactoring labels Jan 12, 2024
@genedna genedna added this to Mega Jan 12, 2024
@genedna genedna added this to the 0.2.0 - Web UI and Tauri App milestone Jan 12, 2024
@genedna
Copy link
Member

genedna commented Jan 12, 2024

@benjamin-747

During the initial setup, including a README.md as part of the initial commit in the root directory would be beneficial. This file can contain essential information about the Mega, offering guidance on how to use it effectively. The content can be designed to help developers quickly understand how to interact with the UI after initialization, providing a clear and concise introduction to the project.

Additionally, it might be helpful to encourage users to customize the README.md file. This could include adding specific information relevant to their implementation or any agreed-upon standards and practices within their development team. Allowing such flexibility would make README.md more useful for individual projects and foster a sense of community contribution and customization.

These steps could significantly enhance the user experience from the project's setup phase, making it easier for developers to get up to speed and contribute more effectively.

@genedna genedna moved this to Backlog in Mega Jan 12, 2024
@genedna
Copy link
Member

genedna commented Jan 20, 2024

@YutingNie ,

After a thorough discussion within @benjamin-747, we've identified a significant problem in the design of Mega. Specifically, the current implementation fails to differentiate between the importation codebase of git and the codebase in the monorepo. This oversight has led to some functional deficiencies in our system.

We're just letting you know that we need a fix to fix this issue. @benjamin-747 is now prioritizing this matter and working diligently to resolve it. Once the necessary repairs are made, we can support this functionality appropriately.

Also, we are aligning our efforts with the requirements outlined in issue #34. This involves the creation of comprehensive documentation to assist developers in swiftly deploying and utilizing Mega. We aim to provide clear, detailed guides that will not only facilitate the use of Mega but also encourage contributions to its features and capabilities.

@genedna genedna linked a pull request Mar 24, 2024 that will close this issue
@genedna genedna closed this as completed May 13, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in Mega May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request refactoring ui
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants