Giter Site home page Giter Site logo

Create ReadMe.md about masterhash HOT 6 CLOSED

MorrisB-- avatar MorrisB-- commented on September 28, 2024
Create ReadMe.md

from masterhash.

Comments (6)

krys2fa avatar krys2fa commented on September 28, 2024

Hello @morrisb, I would like to work on this. Kindly provide further instructions.

from masterhash.

MorrisB-- avatar MorrisB-- commented on September 28, 2024

Nice to meet you @krys2fa, and welcome to the team! MasterHash will is a password manager that allows a user to have an almost infinite amount of passwords while only using their main one. What will make this product different from others on the market is that it will all be stored in one encrypted file which will allow easy transport.

The software will be written mainly in Java, with the GUI written in JavaFX. The goal of the ReadMe should cover these things:

  1. What the software is about, and what it accomplishes
  2. How to get started (cloning the repo, launching the software, etc)
  3. What to do if you find a bug, or have any issues
  4. Guide to Contributing

None of this is set in stone, and I'd love to have all types of feedback, and feel free to model it after other popular repositories. Let me know if you have any questions or ideas.

-Morris

from masterhash.

vhinmanansala avatar vhinmanansala commented on September 28, 2024

Hello @MorrisB-- I'm interested on this as well.

from masterhash.

MorrisB-- avatar MorrisB-- commented on September 28, 2024

Nice to meet you @vhinmanansala, I'm not sure if @krys2fa started working on it yet, but I'm sure it won't be a problem if multiple people start working on it. Especially since the ReadMe will probably need to be refined constantly once development begins. If you have any questions feel free to ask!

-Morris

from masterhash.

krys2fa avatar krys2fa commented on September 28, 2024

Hello @MorrisB-- , I've submitted a PR for review but like you said, @vhinmanansala can chip in once the review is done.

from masterhash.

MorrisB-- avatar MorrisB-- commented on September 28, 2024

Looks great to me @krys2fa! @vhinmanansala feel free to add as you see fit. For example we'll need to add how to set up the project in Eclipse (importing the project, etc.). So if you want to add that please feel free.

I'll be working on more tonight so the coding will start this week!

from masterhash.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.